home *** CD-ROM | disk | FTP | other *** search
/ Experimental BBS Explossion 3 / Experimental BBS Explossion III.iso / msdos / icndos15.zip / ICONEDIT.DOC < prev    next >
Text File  |  1993-06-05  |  14KB  |  283 lines
  1.  
  2.  
  3.                                     ┌────┐
  4.                                  ┌──┴─┐┌─┴──┐
  5.                               ┌──┴─┐┌─┴┴─┐┌─┴──┐
  6.                            ┌──┴─┐┌─┴┴─┐┌─┴┴─┐┌─┴──┐
  7.                         ┌──┴─┐┌─┴┴─┐┌─┴┴─┐┌─┴┴─┐┌─┴──┐
  8.                         │    ├┤    ├┤    ├┤    ├┤    │
  9.                         └────┘└────┘└────┘└────┘└────┘
  10.                                     IconEDIT
  11.                                    ver. 1.1
  12.                           Copyright 1993, EFD Systems
  13.                                All Rights Reserved
  14.                         ┌────┐┌────┐┌────┐┌────┐┌────┐
  15.                         │    ├┤    ├┤    ├┤    ├┤    │
  16.                         └──┬─┘└─┬┬─┘└─┬┬─┘└─┬┬─┘└─┬──┘
  17.                            └──┬─┘└─┬┬─┘└─┬┬─┘└─┬──┘
  18.                               └──┬─┘└─┬┬─┘└─┬──┘
  19.                                  └──┬─┘└─┬──┘
  20.                                     └────┘
  21.  
  22.  
  23.  
  24.  
  25. ─────────────────────────────────────────────────────────────────────────────
  26.                          T A B L E  of  C O N T E N T S
  27.  
  28.  
  29.  Description  ----------------------------------------------------------- 3
  30.  
  31.  Installation and Startup  ---------------------------------------------- 4
  32.  
  33.  Building Menus  -------------------------------------------------------- 5
  34.  
  35.  Editing and Copying Icons  --------------------------------------------- 6
  36.  
  37.  Command Buttons  ------------------------------------------------------- 8
  38.  
  39.  How-To  ---------------------------------------------------------------- 9
  40.  
  41.  Mail Order  ------------------------------------------------------------ 12
  42.  
  43.  Maintenance Log  ------------------------------------------------------- 13
  44.  
  45.  
  46.  
  47.  
  48.  
  49. ───────────────────────────────────────────────────────────────────────────────
  50.                                   Description
  51.  
  52. IconEDIT is the graphical setup and maintenace utility for IconDOS. IconEDIT is
  53. used to build and edit icon menu files containing up to 32767 icons.  With
  54. IconEDIT you can draw your own icons from scratch or you can copy and modify any
  55. of the provided library icons.  At the same time, you can edit an icon's title
  56. and attach a DOS command string and password to the icon.
  57.  
  58. IconEDIT is almost totally mouse driven; therefore, a MicroSoft compatible mouse
  59. is required.  If a mouse driver is not present at startup, IconEDIT will abort
  60. with a short message.  IconEDIT also requires a VGA monitor (EGA will not work).
  61. This condition is also checked at startup.
  62.  
  63. IconDOS icons are always 32 by 32 pixels.  Wallpaper is also a 32 by 32 pixel
  64. graphic that is placed into a special file, PAPER.ICN, for display as a
  65. repeating backdrop pattern.  Therefore, IconEDIT does not make a distinction
  66. between icons and wallpaper and will edit either.  During editing, IconEDIT
  67. displays a normal and an expanded view of the icon.  Drawing with the mouse
  68. always takes place in the expanded view.
  69.  
  70. IconEDIT can now assign a 4 character password to an icon.  The password is
  71. requested from the user before the icon action will be performed.   Passwords
  72. are case insensitive, i.e. caps and lower case are considered to be the same.
  73. ───────────────────────────────────────────────────────────────────────────────
  74.                             Installation and Startup
  75.  
  76. Installation is very easy.  Simply make a new directory and copy all of the
  77. IconDOS files to it.  If you insist, a batch file called INSTALL.BAT has been
  78. provided which will do this for you.  Change to the drive and directory where
  79. the IconDOS files are located and type:
  80.  
  81.                     INSTALL path   Example: INSTALL C:\MENU
  82.  
  83. To start IconEDIT, type:
  84.  
  85.                           ICONEDIT iconfile [buffile]
  86.  
  87. "iconfile" is the name of the file that you wish to edit.  The file will be
  88. created if it does not exist.  "buffile" is the name of an optional
  89. cut/copy/paste buffer file.  If "buffile" is not specified, IconEDIT will create
  90. and use a file called ICON.TMP.  The "buffile" is the key to copying and moving
  91. icons between files.  Try editing DEMO.MNU for practice.
  92.  
  93. NOTE: The buffer file grows in size with each CUT or COPY command.  ICON.TMP is
  94. never deleted or overwritten, only added to.  Therefore, you may wish to delete
  95. this file from time to time in order to prevent it from becoming excessively
  96. large.
  97. ───────────────────────────────────────────────────────────────────────────────
  98.                                  Building Menus
  99.  
  100. An icon menu file can be built by hand drawing icons using IconEDIT; however, it
  101. is easier and faster to copy icons from the provided icon library whenever
  102. possible.  Specific instructions for copying icons using IconEDIT are provided
  103. in the following section.  After icons have been drawn or copied, use IconEDIT
  104. to add icon titles, command strings and passwords.  Due to the command string
  105. size limit of 14 characters, imposed by the IBM keyboard buffer, the command
  106. string is normally used to call a batch file with a parameter.  The batch file
  107. actually contains the list of DOS commands needed to carry out specific icon
  108. actions.  A single batch file file can contain multiple sets of commands, one
  109. set for each icon in a menu.  An icon specific parameter should be passed by
  110. the icon command string to the batch file for use in selecting the proper DOS
  111. command set.  RUN.BAT is a fully commented batch file which illustrates this
  112. technique.  This file can be modified for your own needs as desired.  This batch
  113. file is also used to make the menu system re-entrant by returning control to
  114. IconDOS after a command set has been executed.  Comments in RUN.BAT also
  115. illustrate this.
  116.  
  117. To allow IconDOS to operate from any directory, the batch file containing the
  118. DOS command sets should be located somewhere inside your DOS path.  IconDOS can
  119. be accessed from outside the IconDOS directory by specifying the full path for
  120. both IconDOS and menu file like this:  C:\MENU\ICONDOS C:\MENU\DEMO
  121. ───────────────────────────────────────────────────────────────────────────────
  122.                            Editing and Copying Icons
  123.  
  124. As noted earlier, IconDOS is mostly mouse driven.  Notes on-screen explain how
  125. the CTRL and ALT keys will modify certain mouse actions.  The keyboard is only
  126. used to enter and edit icon titles, command strings and passwords.
  127.  
  128. All drawing takes place in the expanded view of the icon.  Individual pixels are
  129. painted by clicking inside a pixel box.  Lines can be drawn by holding down a
  130. mouse button and moving the cursor.  A wide brush (3 X 3 pixels) is available
  131. for filling in larger regions by holding down the ALT key while drawing.
  132.  
  133. The left and right mouse buttons can be assigned drawing colors by clicking on
  134. the color bar.  To erase instead of draw, simply assign the background color to
  135. one of the buttons and draw over the area to be erased.
  136.  
  137. Note that you must explicitedly store your artwork to disk by clicking either
  138. the SAVE or APPEND command buttons; otherwise, your work will be lost when you
  139. leave IconEDIT or move to the next icon.
  140.  
  141. To edit a title, command string or password, click inside the labeled edit box.
  142. The mouse is disabled until editing is terminated by ENTER or ESC.  The box
  143. editor provides Insert and Overstrike modes toggled with INSERT.  Alt-C will
  144. clear the box, Alt-R will restore.  Home and End move to the box start/end.
  145. ───────────────────────────────────────────────────────────────────────────────
  146.                        Editing and Copying Icons (cont'd)
  147.  
  148. When building a menu, it is generally preferable to copy an icon from the
  149. provided library, ICON.LBR, instead of drawing your own icon from scratch.
  150.  
  151. To copy icons between files, start IconEDIT in the following manner:
  152.  
  153.                         ICONEDIT fromfile tofile
  154.  
  155. For example, to copy an icon from ICON.LBR to MYMENU.MNU, start IconEDIT with:
  156.  
  157.                           ICONEDIT ICON.LBR MYMENU.MNU
  158.  
  159. Step through ICON.LBR until you find the desired icon.  Note that Ctrl and Alt
  160. keys can be used with the NEXT and PREVIOUS command buttons to jump more rapidly
  161. through the file.  Once the icon is found, click COPY.  A copy of the icon will
  162. be placed into MYMENU.MNU.  DO NOT use CUT unless you wish to actually remove
  163. the icon from ICON.LBR as it is being placed into MYMENU.MNU.
  164.  
  165. IconDOS can be used to view the icon library and select icons to be copied.
  166. Simply type ICONDOS ICON.LBR.  Icons are displayed in succession by row, 56 per
  167. page.  Selecting icons and noting their numbers in this way makes them easier to
  168. find and copy later with IconEDIT.
  169. ───────────────────────────────────────────────────────────────────────────────
  170.                                 Command Buttons
  171.  
  172. PREVIOUS - Move to the previous icon in the file.  Hold the Alt key to move in
  173.    steps of 5 icons.  Hold the Ctrl key to move to the start of the file.  The
  174.    current icon number and the total icon count are shown at the upper right.
  175. NEXT - Move to the next icon in the file.  Alt key moves by 5.  Ctrl key moves
  176.    to the end of the file.  When moving, the user is prompted to save the
  177.    current icon if it has been modified.
  178. CLEAR - Clears the icon to the mouse button color.  For example, to clear the
  179.    icon to solid red, assign red to one of the mouse buttons by clicking on the
  180.    color bar and then click CLEAR with the red mouse button.
  181. CUT - Removes the current icon from the file and places it in the buffer file.
  182.    The last icon in the file is moved to fill the current position and the total
  183.    icon count is reduced by 1.
  184. COPY - Copies the current icon to the buffer.  The current file is unchanged.
  185. PASTE - Copy the next icon from the buffer file and overwrite the current icon
  186.    display.  Only the screen display is overwritten, SAVE or APPEND must be used
  187.    to overwrite the icon on disk.  PASTE starts at the end of the buffer file
  188.    and progresses backward with each use in a Last-In-First-Out (LIFO) manner.
  189. APPEND - Adds the currently displayed icon to the end of the file. Increases the
  190.    total icon count by 1.
  191. SAVE - Overwrites the current disk icon number with the displayed icon.
  192. Exit - The window button in the extreme upper left of the screen exits IconEDIT.
  193. ───────────────────────────────────────────────────────────────────────────────
  194.                                      How-To
  195.  
  196. - Add a new icon to a file?
  197.  
  198. Draw or copy a new icon (using Copy or Paste as described above) at any location
  199. in the file.   With the icon is displayed, click the APPEND command button.  The
  200. icon, as currently displayed, will be appended to the end of the file. Ctrl-Next
  201. moves to the end of the file to view or edit the newly appended icon.
  202.  
  203. - View all of the icons in a file?
  204.  
  205. Start IconDOS and specify the file.  For example, ICONDOS ICON.LBR, will display
  206. all of the icons from the provided icon library on successive pages with 56
  207. icons per page.
  208.  
  209. - Setup a submenu?
  210.  
  211. Assign a submenu file name (.MNU extension required) to an icon in place of a
  212. DOS command string.  IconDOS will load the submenu file when the icon is
  213. clicked.  You may want to provide an icon in the submenu which re-loads the
  214. previous menu.  See DEMO.MNU and SUBDEMO.MNU for an example.  All menus and
  215. submenus should always be maintained in the same directory; otherwise, IconDOS
  216. may have trouble locating the needed files.
  217. ───────────────────────────────────────────────────────────────────────────────
  218.                                 How-To (cont'd)
  219.  
  220. - Move icons within a file?
  221.  
  222. Delete the default buffer file, ICON.TMP.  Edit the file using the default
  223. buffer (don't specify a buffer file).   COPY all of the icons to be moved.
  224. PASTE the copied icons into new positions and SAVE, one at a time.
  225.  
  226. - Move icons between files?
  227.  
  228. The most direct way is to edit the file to be copied FROM while using the file
  229. to be copied TO as the cut/copy/paste buffer (see pg. 7).  Alternately, any
  230. icons copied from one file into the default buffer are available for pasting
  231. into any subsequent file being edited.  The default buffer is never deleted or
  232. overwritten, only added to.
  233.  
  234. - Edit or create new wallpaper?
  235.  
  236. Use IconEDIT to edit the wallpaper file, PAPER.ICN, in the same way that you
  237. edit a menu file.  As mentioned previously, icons and wallpaper are structurally
  238. identical. Wallpaper is just an icon that is in a special file.  You really
  239. should make a backup copy of PAPER.ICN before you start editing to avoid any
  240. possibility of mishaps.
  241. ───────────────────────────────────────────────────────────────────────────────
  242.                                    Mail Order
  243.  
  244. To use this software beyond a 30-day trial period requires the purchase of a
  245. license. A license can only be purchased by direct mail order from the author
  246. (just like in the old days with the Sears catalog).  See ORDER.FRM or send a
  247. check or money order for $25 US to:
  248.                                   EFD Systems
  249.                             304 Smokerise Circle SE
  250.                               Marietta, GA 30067                  CIS:72627,3026
  251.  
  252. As a minimum, licensed users will receive the following:
  253.  
  254. - The lastest licensed version of IconDOS including a library of at least 450
  255.   ready-to-use high quality icons and new wallpaper.
  256.  
  257. - A utility to display 16 color PCX files and capture icons from the screen.
  258.   Provides an indirect but workable path to convert Window's icons to IconDOS.
  259.   The icon library was converted from public domain Windows icons in this way.
  260.  
  261. - Information on upgrades and any new utilities not offered as shareware.
  262.   Registered users can upgrade to any later version for a $5 S & H fee.
  263.  
  264.  
  265. ───────────────────────────────────────────────────────────────────────────────
  266.                                 Maintenance Log
  267.  
  268. 1.0 - 1/8/93 (the King's birthday) Original release.
  269.  
  270. 1.1 - 1/21/93 Added password security.
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282. *** End of File ***
  283.